docs/Spektrum bind.md

   1 # Spektrum bind support
   2
   3 Spektrum bind with hardware bind plug support.
   4
   5 The Spektrum bind code is enabled for the boards listed in the section [Supported firmware and hardware ports](#Supported firmware and hardware ports)
   6
   7 ## Developement - configuring the bind code
   8
   9 The following parameters can be used to enable and configure this in the related target.h file:
  10
  11     SPEKTRUM_BIND          Enables the Spektrum bind code
  12     BIND_PORT  GPIOA       Defines the port for the bind pin
  13     BIND_PIN   Pin_3       Defines the bind pin (the satellite receiver is connected to)
  14
  15 This is to activate the hardware bind plug feature
  16
  17     HARDWARE_BIND_PLUG     Enables the hardware bind plug feature
  18     BINDPLUG_PORT  GPIOB   Defines the port for the hardware bind plug
  19     BINDPLUG_PIN   Pin_5   Defines the hardware bind plug pin
  20
  21 ## Hardware
  22
  23 The hardware bind plug will be enabled via defining HARDWARE_BIND_PLUG during building of the firmware. BINDPLUG_PORT and BINDPLUG_PIN also need to be defined (please see above). The hardware bind plug is expected between the defined bind pin and ground.
  24
  25 ## Supported firmware and hardware ports
  26
  27 Note that the bind pin *may* not be the UART pin normally associated with the serial RX.
  28
  29 | Board | Bind Pin | UART Pin |
  30 | ----- | -------- | -------- |
  31 | AIRBOTF4 | PB11 | UART3 RX  |
  32 | AIRHEROF3 | PB11 | UART3 RX  |
  33 | ALIENFLIGHTF3 | PA3 | UART2 RX  |
  34 | BETAFLIGHTF4 | PB11 | UART3 RX  |
  35 | BLUEJAYF4 | PB11 | UART3 RX  |
  36 | FALCORE | PA3 | UART2 RX  |
  37 | FURYF3 | PB11 | UART3 RX  |
  38 | LUX_RACE | PC5 | UART1 RX  |
  39 | MATEKF405 | PA3 | UART2 RX  |
  40 | MATEKF405SE | PA3 | UART2 RX  |
  41 | MATEKF411 | PA10 | UART1 RX  |
  42 | MATEKF411SE | PA3 | UART2 RX  |
  43 | MATEKF722 | PA3 | UART2 RX  |
  44 | MOTOLAB | PB4 | UART2 RX  |
  45 | OMNIBUS | PB11 | UART3 RX  |
  46 | OMNIBUSF4 | PB11 | UART3 RX  |
  47 | PIKOBLX | PB11 | UART3 RX  |
  48 | RCEXPLORERF3 | PA3 | UART2 RX  |
  49 | REVO | PB11 | UART3 RX  |
  50 | RMDO | PB11 | UART3 RX  |
  51 | SPARKY | PA3 | UART2 RX  |
  52 | SPEEDYBEEF4 | PC11 | UART3 RX  |
  53 | SPRACINGF3 | PB11 | UART3 RX  |
  54 | SPRACINGF3EVO | PB11 | UART3 RX  |
  55 | SPRACINGF3MINI | PB11 | UART3 RX  |
  56
  57 *Table automagically generated by `mwptools/samples/spkbind.rb` 2019-08-16. E&OE, update at your own convenience.*
  58
  59 ## Function
  60
  61 The spektrum_sat_bind CLI parameter is defining the number of bind impulses (1-10) send to the satellite receiver. Setting spektrum_sat_bind to zero will disable the bind mode in any case. The bind mode will only be activated after an power on or hard reset. Please refer to the table below for the different possible values.
  62
  63 If the hardware bind plug is configured the bind mode will only be activated if the plug is set during the firmware start-up. The value of the spektrum_sat_bind parameter will be permanently preserved. The bind plug should be always removed for normal flying.
  64
  65 If no hardware bind plug is used the spektrum_sat_bind parameter will trigger the bind process during the next hardware reset and will be automatically reset to "0" after this.
  66
  67 Please refer to the satellite receiver documentation for more details of the specific receiver in bind mode. Usually the bind mode will be indicated with some flashing LEDs.
  68
  69 ## Table with spektrum_sat_bind parameter value
  70
  71 | Value | Receiver mode     |
  72 | ----- | ------------------|
  73 | 3     | DSM2 1024bit/22ms |
  74 | 5     | DSM2 2048bit/11ms |
  75 | 7     | DSMX 1024bit/22ms |
  76 | 9     | DSMX 2048bit/11ms |
  77
  78 More detailed information regarding the satellite binding process can be found here:
  79 http://wiki.openpilot.org/display/Doc/Spektrum+Satellite
  80
  81 #### Tested satellite transmitter combinations
  82
  83 | Satellite            | Remote         | Remark                                                   |
  84 | -------------------- | -------------- | -------------------------------------------------------- |
  85 | Orange R100          | Spektrum DX6i  | Bind value 3                                             |
  86 | Lemon RX DSM2/DSMX   | Spektrum DX8   | Bind value 5                                             |
  87 | Lemon RX DSMX        | Walkera Devo10 | Bind value 9, Deviation firmware 4.01 up to 12 channels  |
  88 | Lemon RX DSM2        | Walkera Devo7  | Bind value 9, Deviation firmware                         |